home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / Cando v1.6 disk 2.adf / HelpFiles / Documents  < prev    next >
Text File  |  1992-01-31  |  8KB  |  365 lines
  1. V- CharsToBegOfLine        |charstobegofline|
  2. V- CharsToEndOfLine        |charstoendofline|
  3. C- Clear                |clear|
  4. C- Delete                |delete|
  5. V- DocumentName            |documentname|
  6. C- InsertDocument        |insertdocument|
  7. V- LengthOfLine            |lengthofline|
  8. V- LinesInDocument        |linesindocument|
  9. C- LoadDocument            |loaddocument|
  10. C- MakeDocument            |makedocument|
  11. C- MoveCursor            |movecursor|
  12. C- MoveCursorTo            |movecursorto|
  13. C- NewLine                |newline|
  14. C- PositionOnLine        |positiononline|
  15. C- Replace                |replace|
  16. C- SaveDocument            |savedocument|
  17. C- SearchFor            |searchfor|
  18. V- SearchFound            |searchfound|
  19. C- SetWordDelimiters    |setworddelimiters|
  20. V- SizeOfDocument        |sizeofdocument|
  21. C- SortDocument            |sortdocument|
  22. C- SplitLine            |splitline|
  23. F- TextFromDocument        |textfromdocument|
  24. V- TheCharacter            |thecharacter|
  25. V- TheColumnNumber        |thecolumnnumber|
  26. V- TheLine                |theline|
  27. V- TheLineNumber        |thelinenumber|
  28. V- TheWord                |theword|
  29. V- TheWordDelimiters    |theworddelimiters|
  30. C- Type                    |type|
  31. C- WorkWithDocument        |workwithdocument|
  32. [E]
  33.  
  34. |charstobegofline|
  35. WT {String}=CharsToBegOfLine
  36. PL The characters before the cursor on the
  37. PL current line, but not including the
  38. PL character that the cursor is on.
  39. PL 
  40. PT SEE ALSO: 
  41. BS CharsToEndOfLine
  42. PT .
  43. ED
  44.  
  45. |charstoendofline|
  46. WT {String}=CharsToEndOfLine
  47. PL The characters after the cursor on the
  48. PL current line, but not including the
  49. PL character that the cursor is on.
  50. PL 
  51. PT SEE ALSO: 
  52. BS CharsToBegOfLine
  53. PT .
  54. ED
  55.  
  56. |clear|
  57. WT Clear <flags>
  58. PL If the flag is DOCUMENT then this command
  59. PL will clear out the whole document where as
  60. PL if the flag is LINE it will clear only the
  61. PL current line.
  62. PL
  63. PT SEE ALSO: 
  64. BS Delete
  65. PT .
  66. ED
  67.  
  68. |delete|
  69. WT Delete <flags> [,{Count}]
  70. PL This command will delete parts of your
  71. PL current document.  The flags include:
  72. PL The flags include CHARACTER, CHARACTERS,
  73. PL LINE, TOSTARTOFLINE and TOENDOFLINE.
  74. PL For a full discussion of this command
  75. PL see page 6-49 of your yellow manual.
  76. ED
  77.  
  78. |documentname|
  79. WT {DocumentBufferName}=DocumentName
  80. PL This returns the buffer name of the
  81. PL current document.
  82. PL
  83. PT SEE ALSO: 
  84. BS WorkWithDocument
  85. PT .
  86. ED
  87.  
  88. |insertdocument|
  89. WT InsertDocument {SourceDocumentName} [,{StartingLine} [,{LineCount}]]
  90. PL Inserts text from the specified document
  91. PL into the current document at the current
  92. PL cursor position.  Optionally, a start line
  93. PL and the number of lines to copy can be
  94. PL specified.
  95. PT SEE ALSO: 
  96. BS Type
  97. PT .
  98. ED
  99.  
  100. |lengthofline|
  101. WT {Integer}=LengthOfLine
  102. PL This returns the number of characters
  103. PL in the current document line.
  104. ED
  105.  
  106. |linesindocument|
  107. WT {Integer}=LinesInDocument
  108. PL This returns the number of lines
  109. PL in the current document.
  110. ED
  111.  
  112. |loaddocument|
  113. WT LoadDocument {FilePath} [,{DocumentBufferName} [,<loadflags>]]
  114. Pl Preload a document, either FTXT or ASCII.
  115. PL See pages 6-46 and 7-7 in the yellow manual
  116. PL and page 6-46 in the 1.50 manual supplement
  117. PL for a full description of this command.
  118. PL
  119. PT SEE ALSO: 
  120. BS SaveDocument
  121. PT .
  122. ED
  123.  
  124. |makedocument|
  125. WT MakeDocument {DocumentBufferName}
  126. PL This command makes an empty document
  127. PL buffer with the name specified.
  128. PL
  129. PT SEE ALSO: 
  130. BS WorkWithDocument
  131. PT .
  132. ED
  133.  
  134. |movecursor|
  135. WT MoveCursor <directionflags> [,{Count}]
  136. PL Moves the cursor, in the given direction,
  137. PL in the document.  The direction flags are
  138. PL UP, DOWN, LEFT and RIGHT.  You may also
  139. PL specify the number of times to move.
  140. PL
  141. PT SEE ALSO: 
  142. BS MoveCursorTo
  143. PT .
  144. ED
  145.  
  146. |movecursorto|
  147. WT MoveCursorTo <flags> [,{Count}]
  148. PL Moves the cursor around in the document.
  149. PL Flags include: STARTOF and ENDOF modifiers
  150. PL and DOCUMENT, LINE, NEXTWORD, THISWORD and
  151. PL PREVIOUSWORD which specify the scope of the
  152. PL movement.  You may also specify the number
  153. PT times to move.  SEE ALSO: 
  154. BS MoveCursor
  155. PT .
  156. ED
  157.  
  158. |newline|
  159. WT NewLine
  160. PL Has the same effect as moving to the end of
  161. PL the current line and hitting the RETURN key.
  162. PL
  163. PT SEE ALSO: 
  164. BS SplitLine
  165. PT .
  166. ED
  167.  
  168. |positiononline|
  169. WT PositionOnLine {LineNumber}
  170. PL Move the cursor to the specified line.
  171. PL
  172. PT SEE ALSO: 
  173. BS TheLineNumber
  174. PT .
  175. ED
  176.  
  177. |replace|
  178. WT Replace {SearchString}, {ReplaceString} [,<flags>]
  179. PL This command does a find and replace in
  180. PL the current document using the given
  181. PL strings.  See page 6-51 in the yellow manual
  182. PL for a description of the optional flags.
  183. PL
  184. PT SEE ALSO: 
  185. BS SearchFor
  186. PT  and 
  187. BS SearchFound
  188. PT .
  189. ED
  190.  
  191. |savedocument|
  192. WT SaveDocument {DocumentBufferName} [,{FilePath} [,<flags>]]
  193. PL Saves the specified document to either its
  194. PL default, original, filepath or to the given
  195. PL filepath.  Optionally you may specify the
  196. PL way to save the document, either FTXT
  197. PL or ASCII.
  198. PT SEE ALSO: 
  199. BS LoadDocument
  200. PT .
  201. ED
  202.  
  203. |searchfor|
  204. WT SearchFor {SearchString} [,<flags>]
  205. PL This command searches the current document
  206. PL for the specified string.
  207. PL See page 6-50 in the yellow manual for a
  208. PL description of the optional flags.
  209. PL
  210. PT SEE ALSO: 
  211. BS Replace
  212. PT  and 
  213. BS SearchFound
  214. PT .
  215. ED
  216.  
  217. |searchfound|
  218. WT {Logical}=SearchFound
  219. PL This variable has many uses and is set by
  220. PL many commands and functions.  The document
  221. PT commands 
  222. BS SearchFor
  223. PT  and 
  224. BS Replace
  225. PL  will set this
  226. PL variable to true if they succeed in finding
  227. PL their search strings.  Also the database
  228. PT system's functions: 
  229. BS SearchArray
  230. PT ,   (more...)
  231. NP searchfound2
  232. ED
  233.  
  234. |searchfound2|
  235. BS NextArrayIndex
  236. PT , 
  237. BS PreviousArrayIndex
  238. PL ,
  239. BS FirstArrayIndex
  240. PT  and 
  241. BS LastArrayIndex
  242. PL 
  243. PL will set the SearchFound variable if they
  244. PL succeed.
  245. PP searchfound
  246. ED
  247.  
  248. |setworddelimiters|
  249. WT SetWordDelimiters {WordDelimiters}
  250. PL This defines the current document's word
  251. PL delimiter character set.  This may change
  252. PL the results of many document commands,
  253. PL functions and variables.
  254. PL
  255. PT SEE ALSO: 
  256. BS TheWordDelimiters
  257. PT  and 
  258. BS TheWord
  259. PT .
  260. ED
  261.  
  262. |sizeofdocument|
  263. WT {Integer}=SizeOfDocument
  264. PL This returns the size in characters of the
  265. PL current document.
  266. ED
  267.  
  268. |sortdocument|
  269. WT SortDocument <flags> [,{StartingColumn}]
  270. PL This command sorts the current document.
  271. PL For a full discussion of this command
  272. PL page 6-46 in the 1.50 manual supplement.
  273. ED
  274.  
  275. |splitline|
  276. WT SplitLine [{Count}]
  277. PL Has the same effect as a RETURN key in the
  278. PL current document.  You may also specify the
  279. PL number of times to do this.
  280. PL
  281. PT SEE ALSO: 
  282. BS NewLine
  283. PT .
  284. ED
  285.  
  286. |textfromdocument|
  287. WT {String}=TextFromDocument(DocumentName)
  288. PL This returns the contents of a document
  289. PL as a single, sometimes large, text string.
  290. PL For a full discussion of this function
  291. PL page 6-46 in the 1.50 manual supplement.
  292. ED
  293.  
  294. |thecharacter|
  295. WT {String}=TheCharacter
  296. PL This returns the character that the document
  297. PL cursor is on.  If the cursor is at the end
  298. PT of the document then a 
  299. BS Nothing
  300. PT  is returned.
  301. ED
  302.  
  303. |thecolumnnumber|
  304. WT {Integer}=TheColumnNumber
  305. PL This returns the current column number in
  306. PL the document that the cursor is on.
  307. ED
  308.  
  309. |theline|
  310. WT {String}=TheLine
  311. PL This returns the line that the document
  312. PL cursor is on.  If the cursor is on an empty
  313. PT line then a 
  314. BS Nothing
  315. PT  is returned.
  316. ED
  317.  
  318. |thelinenumber|
  319. WT {Integer}=TheLineNumber
  320. PL This returns the current line number in
  321. PL the document that the cursor is on.
  322. ED
  323.  
  324. |theword|
  325. WT {String}=TheWord
  326. PL This returns the word that the document
  327. PL cursor is on.  If the cursor is on an empty
  328. PT line then a 
  329. BS Nothing
  330. PL  is returned.
  331. PL Remember that what this variable returns
  332. PT depends on how 
  333. BS TheWordDelimiters
  334. PL  is set up.
  335. ED
  336.  
  337. |theworddelimiters|
  338. WT {String}=TheWordDelimiters
  339. PL This returns the current document's word
  340. PL delimiters character set.
  341. PL
  342. PT SEE ALSO: 
  343. BS SetWordDelimiters
  344. PT .
  345. ED
  346.  
  347. |type|
  348. WT Type {String} [,<flag>]
  349. PL This command types the given string into
  350. PL the current document.  If the NEWLINE flag
  351. PL is given the a RETURN is typed at the end
  352. PL of the string.
  353. ED
  354.  
  355. |workwithdocument|
  356. WT WorkWithDocument {DocumentBufferName}
  357. PL All subsequent document commands, functions
  358. PL and variables will use the specified
  359. PL as their current document.
  360. PL
  361. PT SEE ALSO: 
  362. BS MakeDocument
  363. PT .
  364. ED
  365.